﻿/*
Copyright © 2011 François Karman

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

See <license.txt> for the complete license of the software.
*/

using System.Collections.Generic;

namespace Simple.Storage
{
    /// <summary>
    /// Defines the data source concept.
    /// </summary>
    /// <remarks>
    /// The implementations of this interface should be immutable to avoid any side effect.
    /// </remarks>
    public interface IDataSourceDefinition
    {
        /// <summary>
        /// Gets the name of the data source.
        /// </summary>
        /// <remarks>
        /// Should be unique in the encapsulating application to avoid collision during
        /// save and load operations.
        /// </remarks>
        string Name { get; }

        /// <summary>
        /// Gets the definitions of the classes that compose the data source.
        /// </summary>
        ICollection<IClassDefinition> Classes { get; }

        /// <summary>
        /// Gets the definitions of the indexes associated to the data source.
        /// </summary>
        ICollection<IIndexDefinition> Indexes { get; }
    }
}
